User Tools

Site Tools


api_details

API Details

This page explains how each of the methods in BusLayer class are being used by Evolynx RADIUS server.

Authenticate

Authenticate method is called by the RADIUS engine when a new Access-Request RADIUS packet arrives. Based on the result of this method, RADIUS engine sends a response to client:

  • 0: Reject the authentication request
  • 1: Accept the authentication request
  • 2: Send a challenge response

AccountingStart

AccountingStart is called by the RADIUS engine when a new Accounting request RADIUS packet arrives for Acct-Status-Type = 1.

AccountingStop

AccountingStart is called by the RADIUS engine when a new Accounting request RADIUS packet arrives for Acct-Status-Type = 2.

AccountingOther

AccountingStart is called by the RADIUS engine when a new Accounting request RADIUS packet arrives for Acct-Status-Type other than 1 or 2.

OnForwardRequest

This method is called when an access request needs to be forwarded to another RADIUS server.

OnForwardAccounting

This method is called when an accounting request needs to be forwarded to another RADIUS server.

OnForwardToNAS

This method is called when a proxy response needs to be sent back to client.

LoadClients

LoadClients is called during the start of the service, or when a command 131 is sent to the server. This method is responsible for loading the client information.

WriteError

This method is used to log a message in a custom error log, for example a database or a log server.

NotifyByEmail

This method is called by the RADIUS service once a day on a time defined in the configuration. It can be used for any task that needs to be done only once a day.

ScheduledMaintenance

This method is called by the RADIUS service on an interval defined in the configuration. It can be used to do a maintenance type activity multiple times per day.

api_details.txt · Last modified: 2023/08/14 06:41 (external edit)