1
0
mirror of https://github.com/osmarks/ngircd.git synced 2025-02-07 12:50:03 +00:00

Clean up an document Client_Hostname() and Client_Mask()

This commit is contained in:
Alexander Barton 2010-08-17 20:51:14 +02:00
parent f72e22d361
commit 617640e0a3

View File

@ -647,6 +647,11 @@ Client_OrigUser(CLIENT *Client) {
#endif #endif
/**
* Return the hostname of a client.
* @param Client Pointer to client structure
* @return Pointer to client hostname
*/
GLOBAL char * GLOBAL char *
Client_Hostname(CLIENT *Client) Client_Hostname(CLIENT *Client)
{ {
@ -727,20 +732,27 @@ Client_NextHop( CLIENT *Client )
/** /**
* return Client-ID ("client!user@host"), this ID is needed for e.g. * Return ID of a client: "client!user@host"
* prefixes. Returnes pointer to static buffer. * This client ID is used for IRC prefixes, for example.
* Please note that this function uses a global static buffer, so you can't
* nest invocations without overwriting erlier results!
* @param Client Pointer to client structure
* @return Pointer to global buffer containing the client ID
*/ */
GLOBAL char * GLOBAL char *
Client_Mask( CLIENT *Client ) Client_Mask( CLIENT *Client )
{ {
static char GetID_Buffer[GETID_LEN]; static char Mask_Buffer[GETID_LEN];
assert (Client != NULL); assert (Client != NULL);
if( Client->type == CLIENT_SERVER ) return Client->id; /* Servers: return name only, there is no "mask" */
if (Client->type == CLIENT_SERVER)
return Client->id;
snprintf(GetID_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user, Client->host); snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
return GetID_Buffer; Client->id, Client->user, Client->host);
return Mask_Buffer;
} /* Client_Mask */ } /* Client_Mask */