Page MenuHomePhorge
Files F120824804

message_guid.h
No OneTemporary
Actions

Authored By
Unknown
Size
4 KB
Referenced Files
None
Subscribers
None

message_guid.h
View Options

/* message_guid.h -- GUID manipulation
*
* Copyright (c) 1994-2008 Carnegie Mellon University. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The name "Carnegie Mellon University" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For permission or any legal
* details, please contact
* Carnegie Mellon University
* Center for Technology Transfer and Enterprise Creation
* 4615 Forbes Avenue
* Suite 302
* Pittsburgh, PA 15213
* (412) 268-7393, fax: (412) 268-7395
* innovation@andrew.cmu.edu
*
* 4. Redistributions of any form whatsoever must retain the following
* acknowledgment:
* "This product includes software developed by Computing Services
* at Carnegie Mellon University (http://www.cmu.edu/computing/)."
*
* CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
* THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
* FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
* $Id: message_guid.h,v 1.7 2010/01/06 17:01:37 murch Exp $
*/
#ifndef MESSAGE_GUID_H
#define MESSAGE_GUID_H
/* Public interface */
#define MESSAGE_GUID_SIZE (20) /* Size of GUID byte sequence */
enum guid_status {
GUID_UNKNOWN = -1, /* Unknown if GUID is [non-]NULL (not yet tested) */
GUID_NULL = 0, /* GUID is NULL */
GUID_NONNULL = 1, /* GUID is non-NULL */
};
struct message_guid {
enum guid_status status;
unsigned char value[MESSAGE_GUID_SIZE];
};
/* Generate GUID from message */
void message_guid_generate(struct message_guid *guid,
const char *msg_base, unsigned long msg_len);
/* Copy a GUID */
void message_guid_copy(struct message_guid *dst, const struct message_guid *src);
/* Compare a pair of GUIDs: Returns 1 => match. NULL GUIDs do not match. */
int message_guid_compare(struct message_guid *guid1,
struct message_guid *guid2);
/* Compare a pair of GUIDs: Returns 1 => match. NULL GUIDs match anything. */
int message_guid_compare_allow_null(struct message_guid *guid1,
struct message_guid *guid2);
/* Convert GUID into hash value for hash table lookup
* Returns: positive int in range [0, hash_size-1]
*/
unsigned long message_guid_hash(const struct message_guid *guid, int hash_size);
/* Create a NULL GUID */
void message_guid_set_null(struct message_guid *guid);
/* Returns 1 if GUID is NULL value */
int message_guid_isnull(struct message_guid *guid);
/* Export Message GUID as byte sequence (MESSAGE_GUID_SIZE)
* (Wrapper for memcpy() with current implementation)
*/
void message_guid_export(const struct message_guid *guid, unsigned char *buf);
/* Import Message GUID from packed sequence (MESSAGE_GUID_SIZE)
* (Wrapper for memcpy() with current implementation)
*/
struct message_guid *message_guid_import(struct message_guid *guid,
const unsigned char *buf);
/* Routines for manipulating text value */
/* Returns ptr to '\0' terminated static char * which can be strdup()ed
* NULL => error. Should be impossible as entire range covered
*/
char *message_guid_encode(const struct message_guid *guid);
/* Sets Message GUID from text form. Returns 1 if valid
* Returns: Cyrus error code, 0 on sucess
*/
int message_guid_decode(struct message_guid *guid, const char *text);
#endif /* MESSAGE_GUID_H */

File Metadata

Mime Type
text/x-c
Expires
Fri, Apr 24, 10:28 AM (1 d, 14 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
18728115
Default Alt Text
message_guid.h (4 KB)

Event Timeline