org.onosproject.lisp.msg.protocols

Interface LispMapRegister

All Superinterfaces:

LispMessage

All Known Implementing Classes:

DefaultLispMapRegister

public interface LispMapRegister
extends LispMessage

LISP map register message interface.

LISP map register message format is defined in RFC6830. https://tools.ietf.org/html/rfc6830#page-37

 
      0                   1                   2                   3
      0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |Type=3 |P|            Reserved               |M| Record Count  |
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |                         Nonce . . .                           |
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |                         . . . Nonce                           |
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |            Key ID             |  Authentication Data Length   |
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     ~                     Authentication Data                       ~
 +-> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |   |                          Record TTL                           |
 |   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 R   | Locator Count | EID mask-len  | ACT |A|      Reserved         |
 e   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 c   | Rsvd  |  Map-Version Number   |        EID-Prefix-AFI         |
 o   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 r   |                          EID-Prefix                           |
 d   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  /|    Priority   |    Weight     |  M Priority   |   M Weight    |
 | L +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 | o |        Unused Flags     |L|p|R|           Loc-AFI             |
 | c +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  \|                             Locator                           |
 +-> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LispMapRegister.RegisterBuilder A builder of LISP map register message.

Nested classes/interfaces inherited from interface org.onosproject.lisp.msg.protocols.LispMessage

LispMessage.Builder

Method Summary

Modifier and Type	Method and Description
byte[]	getAuthData() Obtains authentication data.
short	getAuthDataLength() Obtains authentication data length.
short	getKeyId() Obtains key identifier.
List<LispMapRecord>	getMapRecords() Obtains a collection of records.
long	getNonce() Obtains nonce value.
int	getRecordCount() Obtains record count value.
boolean	isProxyMapReply() Obtains proxy map reply flag.
boolean	isWantMapNotify() Obtains want map notify flag.

Methods inherited from interface org.onosproject.lisp.msg.protocols.LispMessage

configSender, createBuilder, getSender, getType, writeTo

Method Detail

isProxyMapReply

boolean isProxyMapReply()

Obtains proxy map reply flag.

Returns:

proxy map reply flag

isWantMapNotify

boolean isWantMapNotify()

Obtains want map notify flag.

Returns:

want map notify flag

getRecordCount

int getRecordCount()

Obtains record count value.

Returns:

record count value

getNonce

long getNonce()

Obtains nonce value.

Returns:

nonce value

getKeyId

short getKeyId()

Obtains key identifier.

Returns:

key identifier

getAuthDataLength

short getAuthDataLength()

Obtains authentication data length.

Returns:

authentication data length

getAuthData

byte[] getAuthData()

Obtains authentication data.

Returns:

authentication data

getMapRecords

List<LispMapRecord> getMapRecords()

Obtains a collection of records.

Returns:

a collection of records