'ODTONE - Open Dot Twenty One'
PrevUpHomeNext

Struct frame

odtone::mih::frame

Synopsis

// In header: </home/carlos/Projectos/odtone/inc/odtone/mih/frame.hpp>


struct frame {

  // public static functions
  static frame * cast(void *, size_t);
  static const frame * cast(const void *, size_t);

  // public member functions
  void version(uint8);
  void ackreq(bool);
  void ackrsp(bool);
  void uir(bool);
  void m(bool);
  void fn(uint8);
  void sid(service::type);
  void opcode(operation::type);
  void aid(action::type);
  void mid(uint16);
  void tid(uint16);
  void plength(uint16);
  uint8 version() const;
  bool ackreq() const;
  bool ackrsp() const;
  bool uir() const;
  bool m() const;
  uint8 fn() const;
  bool rsvd1() const;
  service::type sid() const;
  operation::type opcode() const;
  action::type aid() const;
  uint16 mid() const;
  uint8 rsvd2() const;
  uint16 tid() const;
  uint16 plength() const;
  uint8 * payload();
  const uint8 * payload() const;
  size_t length() const;

  // public data members
  static const uint8 mask_version;
  static const uint8 mask_ackreq;
  static const uint8 mask_ackrsp;
  static const uint8 mask_uir;
  static const uint8 mask_m;
  static const uint8 mask_fn;
  static const uint8 mask_rsvd1;
  static const uint8 mask_sid;
  static const uint8 mask_opcode;
  static const uint8 mask_aid;
  static const uint8 mask_rsvd2;
  static const uint8 mask_tid;
  uint8 hdr;
};

Description

MIH message frame. This class provides access to all fields of the MIH message header.

frame public static functions

  1. static frame * cast(void * buff, size_t len);

    Convert a byte buffer to a frame.

    Parameters:

    buff

    The byte buffer.

    len

    The size of the byte buffer.

    Returns:

    The pointer of the returning frame. 

  2. static const frame * cast(const void * buff, size_t len);

    Convert a byte buffer to a frame.

    Parameters:

    buff

    The byte buffer.

    len

    The size of the byte buffer.

    Returns:

    The pointer of the returning frame.

frame public member functions

  1. void version(uint8 v);

    Set the MIH Message Version.

    Parameters:

    v

    The value of the MIH Message Version field. 

  2. void ackreq(bool v);

    Set the MIH Message Acknowledge Request Flag.

    Parameters:

    v

    The value of the MIH Message Acknowledge Request Flag field. 

  3. void ackrsp(bool v);

    Set the MIH Message Acknowledge Response Flag.

    Parameters:

    v

    The value of the MIH Message Acknowledge Response Flag field. 

  4. void uir(bool v);

    Set the MIH Message Unauthenticated Information Request Flag.

    Parameters:

    v

    The value of the MIH Message Unauthenticated Information Request Flag. 

  5. void m(bool v);

    Set the MIH Message More Fragment Flag.

    Parameters:

    v

    The value of the MIH Message More Fragment Flag. 

  6. void fn(uint8 v);

    Set the MIH Message Fragment Number.

    Parameters:

    v

    The value of the MIH Message Fragment Number. 

  7. void sid(service::type v);

    Set the MIH Message ID Service Identifier.

    Parameters:

    v

    The value of the MIH Message ID Service Identifier. 

  8. void opcode(operation::type v);

    Set the MIH Message ID Operation Code.

    Parameters:

    v

    The value of the MIH Message ID Operation Code. 

  9. void aid(action::type v);

    Set the MIH Message ID Action Identifier.

    Parameters:

    v

    The value of the MIH Message ID Action Identifier. 

  10. void mid(uint16 v);

    Set the MIH Message ID.

    Parameters:

    v

    The value of the MIH Message Message ID. 

  11. void tid(uint16 v);

    Set the MIH Message Transaction ID.

    Parameters:

    v

    The value of the MIH Message Transaction ID. 

  12. void plength(uint16 v);

    Set the message payload length.

    Parameters:

    v

    The value of the message payload length. 

  13. uint8 version() const;

    Get the MIH Message Version.

    Returns:

    The value of the MIH Message Version field. 

  14. bool ackreq() const;

    Get the MIH Message Acknowledge Request Flag.

    Returns:

    The value of the MIH Message Acknowledge Request Flag. 

  15. bool ackrsp() const;

    Get the MIH Message Acknowledge Response Flag.

    Returns:

    The value of the MIH Message Acknowledge Response Flag field. 

  16. bool uir() const;

    Get the MIH Message Unauthenticated Information Request Flag.

    Returns:

    The value of the MIH Message Unauthenticated Information Request Flag. 

  17. bool m() const;

    Get the MIH Message More Fragment Flag.

    Returns:

    The value of the MIH Message More Fragment Flag. 

  18. uint8 fn() const;

    Get the MIH Message Fragment Number.

    Returns:

    The value of the MIH Message Fragment Number. 

  19. bool rsvd1() const;

    Get the MIH Reserved Bit 1.

    Returns:

    The value of the MIH Reserved Bit 1. 

  20. service::type sid() const;

    Get the MIH Message ID Service Identifier.

    Returns:

    The value of the MIH Message ID Service Identifier. 

  21. operation::type opcode() const;

    Get the MIH Message ID Operation Code.

    Returns:

    The value of the MIH Message ID Operation Code. 

  22. action::type aid() const;

    Get the MIH Message ID Action Identifier.

    Returns:

    The value of the MIH Message ID Action Identifier. 

  23. uint16 mid() const;

    Get the MIH Message ID.

    Returns:

    The value of the MIH Message ID. 

  24. uint8 rsvd2() const;

    Get the MIH Reserved Bit 2.

    Returns:

    The value of the MIH Reserved Bit 2. 

  25. uint16 tid() const;

    Get the MIH Message Transaction ID.

    Returns:

    The value of the MIH Message Transaction ID. 

  26. uint16 plength() const;

    Get the message payload length.

    Returns:

    The message payload length. 

  27. uint8 * payload();

    Get the pointer of the message payload.

    Returns:

    The pointer of the message payload. 

  28. const uint8 * payload() const;

    Get the pointer of the message payload.

    Returns:

    The pointer of the message payload. 

  29. size_t length() const;

    Get the length of the frame.

    Returns:

    The length of the frame.

frame public public data members

  1. static const uint8 mask_version;

    MIH Message Version mask. 

  2. static const uint8 mask_ackreq;

    MIH Message Acknowledge Request Flag mask. 

  3. static const uint8 mask_ackrsp;

    MIH Message Acknowledge Response Flag mask. 

  4. static const uint8 mask_uir;

    MIH Message Unauthenticated Information Request Flag mask. 

  5. static const uint8 mask_m;

    MIH Message More Fragment Flag mask. 

  6. static const uint8 mask_fn;

    MIH Message Fragment Number mask. 

  7. static const uint8 mask_rsvd1;

    MIH Message Reserved Bit 1 mask. 

  8. static const uint8 mask_sid;

    MIH Message ID Service Identifier mask. 

  9. static const uint8 mask_opcode;

    MIH Message ID Operation Code mask. 

  10. static const uint8 mask_aid;

    Message ID Action Identifier mask. 

  11. static const uint8 mask_rsvd2;

    MIH Message Reserved Bit 2 mask. 

  12. static const uint8 mask_tid;

    Message ID Transaction Identifier mask. 

  13. uint8 hdr;

    Frame bytes.

Copyright © 2009-2013 Universidade Aveiro
Copyright © 2009-2013 Instituto de Telecomunicações - Pólo Aveiro

This software is distributed under a license. The full license agreement can be found in the LICENSE in this distribution. This software may not be copied, modified, sold or distributed other than expressed in the named license agreement. This software is distributed without any warranty.

PrevUpHomeNext