message.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef message_h
#define message_h
 
#include <hicn/hicn-light/config.h>
#include <hicn/core/logger.h>
#include <hicn/core/messagePacketType.h>
#include <hicn/core/streamBuffer.h>
 
#include <hicn/core/name.h>
 
#include <parc/algol/parc_EventBuffer.h>
#include <parc/algol/parc_EventQueue.h>
 
#include <hicn/utils/address.h>
 
#include <hicn/core/ticks.h>
 
struct message;
typedef struct message Message;
 
Message *message_CreateFromEventBuffer(PARCEventBuffer *data, size_t dataLength,
                                       unsigned ingressConnectionId,
                                       Ticks receiveTime, Logger *logger);
 
Message *message_CreateFromByteArray(unsigned connid, uint8_t *pckt,
                                     MessagePacketType type, Ticks receiveTime,
                                     Logger *logger);
 
Message *message_Acquire(const Message *message);
 
void message_Release(Message **messagePtr);
 
bool message_Write(PARCEventQueue *parcEventQueue, const Message *message);
 
size_t message_Length(const Message *message);
 
bool message_HasWldr(const Message *message);
 
bool message_IsWldrNotification(const Message *message);
 
void message_ResetWldrLabel(Message *message);
 
unsigned message_GetWldrLabel(const Message *message);
 
unsigned message_GetWldrExpectedLabel(const Message *message);
 
unsigned message_GetWldrLastReceived(const Message *message);
 
void message_SetWldrLabel(Message *message, uint16_t label);
 
Message *message_CreateWldrNotification(Message *original, uint16_t expected,
                                        uint16_t lastReceived);
unsigned message_GetIngressConnectionId(const Message *message);
 
void message_SetIngressConnectionId(Message *message, unsigned conn);
 
Ticks message_GetReceiveTime(const Message *message);
 
MessagePacketType message_GetType(const Message *message);
 
uint32_t message_GetPathLabel(const Message *message);
void message_SetPathLabel(Message *message, uint32_t label);
void message_UpdatePathLabel(Message *message, uint8_t outFace);
void message_ResetPathLabel(Message *message);
 
// ===========================================================
// Accessors used to index and compare messages
 
Name *message_GetName(const Message *message);
 
bool message_HasInterestLifetime(const Message *message);
 
uint64_t message_GetInterestLifetimeTicks(const Message *message);
 
bool message_HasContentExpiryTime(const Message *message);
 
uint64_t message_GetContentExpiryTimeTicks(const Message *message);
 
const uint8_t *message_FixedHeader(const Message *message);
 
#endif  // message_h