Preface

The starting point for developing a client using the AnyConnect API is the file ClientIfc. This file contains a series of protected methods most of which must be implemented by the client developer.

The public methods are available to the client developer based on data needed by their applicaiton or actions they want executed. A typical implementation is to call the attach method. Once this completes successfully, the connect method can be called. On subsequent connections, the connect method happens automatically as the last host visited is automatically contacted when the client is started.

After a gateway has been contacted, the method UserPromptCB is called. This method delivers an instance of the object ConnectPromptInfo, which contains user messages and any authentication prompt requests. After setting the desired data, the client developer can call UserSubmit to have the credentials delivered to the Gateway. There is also a method of authentication called certificate-only. If this mechanism of authentication is used, there are no calls to UserPromptCB. Instead, the StateCB method is called, letting the user know that the VPN is Connected.

In the documentation for the ClientIfc interface, some of the methods have a reference "Implemented in ClientImpl". Follow these links to see code snippets that show details of how to interact with data used in the API.

Introduction

The following documentation details the AnyConnect VPN Client C++ API. The documentation consists of two demo programs which show usage of the API functionality. For additional information on how to use the API, read the documentation provdied and browse the Class hierarchy.