libHartwer - Documentation
Enumerations | Functions

bcs_errorcodes.h File Reference

Error codes for libHartwer. More...

Go to the source code of this file.

Enumerations

enum  BCS_ERROR {
  BCS_ERR_OK = 0, BCS_ERR_CONNECTIONCLOSED = 2, BCS_ERR_GENERAL = -1, BCS_ERR_OUTOFMEM = 3,
  BCS_ERR_NOTALLOWED = 4, BCS_ERR_KEY_FAILURE = 5, BCS_ERR_SIZE = 6, BCS_ERR_WRONGARGS = 7,
  BCS_ERR_NOTSENT = 8, BCS_ERR_EMPTY = 9, BCS_ERR_TIMEOUT = 10
}
 

Error constants used throughout libhartwer.

More...

Functions

const char * bcs_strerror (BCS_ERROR e)
 Use this function to get a string explaining the returned error value or details for BCS_ERR_GENERAL.

Detailed Description

Date:
18.04.2009
Author:
Marius Zwicker This file defines human readable error definitions for return error codes of libHartwer functions. They allow a quick conclusion. In all cases it still might be good to check bcs_strerror.

Enumeration Type Documentation

enum BCS_ERROR
Enumerator:
BCS_ERR_OK 

No error occured.

Everything worked fine.

BCS_ERR_CONNECTIONCLOSED 

Tcp connection was closed by remote client.

BCS_ERR_GENERAL 

An unspecified error occured, check bcs_strerror for detailed error descriptions.

BCS_ERR_OUTOFMEM 

Allocation of memory failed.

Not enough memory available or all slots used.

BCS_ERR_NOTALLOWED 

Action is not allowed.

E.g. you tried to write where you have read access only.

BCS_ERR_KEY_FAILURE 

An error occured while generating a unique key for identifying your connection.

BCS_ERR_SIZE 

You tried to write or read too much data.

Decrease the number of bytes and try again.

BCS_ERR_WRONGARGS 

One of your given arguments has an inacceptable value.

BCS_ERR_NOTSENT 

Message could not be sent.

BCS_ERR_EMPTY 

Nothing available to be read.

BCS_ERR_TIMEOUT 

The request timed out, please try again later.


Function Documentation

const char* bcs_strerror ( BCS_ERROR  e)
Parameters:
ea value
Returns:
a string giving a short description

Generated on Fri Feb 11 2011 18:25:46 for libHartwer by Doxygen 1.7.3
Content © 2009-2011 Elefant Racing Bayreuth & MLBA (About) – Design © 2010 Emzeat. All Rights reserved.